<script type="text/javascript"
     src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
</script>

<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->

<head>
    <link rel="stylesheet" href="stylesheet_TMATS.css">
</head>

<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->

<title>
    T-MATS: Help for Flow Add (Cantera) Library Block
</title>

<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->

<body>
    <h1>
      T-MATS: Flow Add (Cantera) Library Block
    </h1>
<hr>
<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->

<div class="purpose">
        Purpose
</div>

<p>
    This block is used to add two flows together. When using this block,
    the secondary flow will be added to the primary flow and the outputs will
    be determined by using Cantera functions and conserving both mass and enthalpy.
</p>
<br>
<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->

<div class="background">
        Background
</div>

<p>
    To determine the output flow, this block adds the secondary flow to the
    primary flow and determines the output parameters by conserving both
    enthalpy and mass. Output pressure is set to remain
    equal to the input primary flow pressure. For this block only total values will be populated.
</p>
<p>
    To utilize this block, a Cantera object must exist in the workspace as
	a global variable named 'fs', which may be created with the Cantera
	'importPhase' command. This variable must include all Species defined
    in the file 'canteraload.m', found at ...\TMATS_Library\MATLAB_Scripts\Cantera_Enabled\+TMATSC.
</p>
<p>
Example MATLAB setup command:
<code>
	<br>global fs
	<br>fs = importPhase('gri30.cti')
</code>
</p>
<br>
<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->

<div class="instructions">
        Instructions
</div>

<p>
    To use this block:
    <ul>
        <li> Ensure that a Cantera object exists in the workspace as a global
        variable named 'fs' and contains all of the species defined in the
        file 'canteraload.m'.
        <ul>
            <li><em>Note:</em>This can be created with the Cantera 'importPhase'
            command.
        </ul>
        <li> Connect the primary and secondary flow inputs to the
        corresponding place on the block.
        <li> Connect the outputs to the next blocks in your simulation.
    </ul>
</p>


<br><hr><br>
<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->

<div class="inputs">
        Flow Add (Cantera) Inputs
</div>

<table>
    <tr><th> Input </th><th>Description</th></tr>
    <tr><td>Flow primary</td><td>Primary Flow, 25x1 vector consisting of:
            <br>-1- &nbsp;&nbsp; W  &nbsp;&nbsp;   - Gas path flow [pps]
            <br>-2- &nbsp;&nbsp; s  &nbsp;&nbsp;    - Entropy [BTU/(lbm*degR)]
            <br>-3- &nbsp;&nbsp; Tt &nbsp;&nbsp;    - Total temperature [degR]
            <br>-4- &nbsp;&nbsp; Pt &nbsp;&nbsp;     - Total pressure [psia]
            <br>-5- &nbsp;&nbsp; ht  &nbsp;&nbsp;    - Total enthlapy [BTU/lbm]
            <br>-6- &nbsp;&nbsp;  rhot &nbsp;&nbsp;  - Total density [lbm/ft3]
            <br>-7- &nbsp;&nbsp; gamt  &nbsp;&nbsp;  - Total specific heat ratio
            <br>-8- &nbsp;&nbsp; Ts    &nbsp;&nbsp;   - Static temperature [degR]
            <br>-9- &nbsp;&nbsp; Ps    &nbsp;&nbsp;   - Static pressure [psia]
            <br>-10- &nbsp;&nbsp; hs   &nbsp;&nbsp;  - Static enthalpy [BTU/lbm]
            <br>-11- &nbsp;&nbsp; rhos  &nbsp;&nbsp;  - Static density [lbm/ft3]
            <br>-12- &nbsp;&nbsp; gams  &nbsp;&nbsp;   - Static specific heat ratio
            <br>-13- &nbsp;&nbsp; Vflow &nbsp;&nbsp;  - Flow velocity [ft/sec]
            <br>-14- &nbsp;&nbsp; MN    &nbsp;&nbsp;  - Mach number
            <br>-15- &nbsp;&nbsp; A     &nbsp;&nbsp;   - Flow area [in2]
            <br>-16to21-  &nbsp;&nbsp; Species array values, defined in canteraload.m
            <br>-22to25-  &nbsp;&nbsp; Future use
    </td></tr>
    <tr><td>Flow secondary</td><td>Secondary Flow, 25x1 vector consisting of:
            <br>-1- &nbsp;&nbsp; W  &nbsp;&nbsp;   - Gas path flow [pps]
            <br>-2- &nbsp;&nbsp; s  &nbsp;&nbsp;    - Entropy [BTU/(lbm*degR)]
            <br>-3- &nbsp;&nbsp; Tt &nbsp;&nbsp;    - Total temperature [degR]
            <br>-4- &nbsp;&nbsp; Pt &nbsp;&nbsp;     - Total pressure [psia]
            <br>-5- &nbsp;&nbsp; ht  &nbsp;&nbsp;    - Total enthlapy [BTU/lbm]
            <br>-6- &nbsp;&nbsp;  rhot &nbsp;&nbsp;  - Total density [lbm/ft3]
            <br>-7- &nbsp;&nbsp; gamt  &nbsp;&nbsp;  - Total specific heat ratio
            <br>-8- &nbsp;&nbsp; Ts    &nbsp;&nbsp;   - Static temperature [degR]
            <br>-9- &nbsp;&nbsp; Ps    &nbsp;&nbsp;   - Static pressure [psia]
            <br>-10- &nbsp;&nbsp; hs   &nbsp;&nbsp;  - Static enthalpy [BTU/lbm]
            <br>-11- &nbsp;&nbsp; rhos  &nbsp;&nbsp;  - Static density [lbm/ft3]
            <br>-12- &nbsp;&nbsp; gams  &nbsp;&nbsp;   - Static specific heat ratio
            <br>-13- &nbsp;&nbsp; Vflow &nbsp;&nbsp;  - Flow velocity [ft/sec]
            <br>-14- &nbsp;&nbsp; MN    &nbsp;&nbsp;  - Mach number
            <br>-15- &nbsp;&nbsp; A     &nbsp;&nbsp;   - Flow area [in2]
            <br>-16to21-  &nbsp;&nbsp; Species array values, defined in canteraload.m
            <br>-22to25-  &nbsp;&nbsp; Future use
    </td></tr>
</table>

<br><br>
<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->

<div class="outputs">
        Flow Add (Cantera) Outputs
</div>

<table>
    <tr><th> Output </th><th> Description </th></tr>
    <tr><td>Flow Out</td><td>Flow Data Output, 25x1 vector consisting of:
            <br>-1- &nbsp;&nbsp; W  &nbsp;&nbsp;   - Gas path flow [pps]
            <br>-2- &nbsp;&nbsp; s  &nbsp;&nbsp;    - Entropy [BTU/(lbm*degR)]
            <br>-3- &nbsp;&nbsp; Tt &nbsp;&nbsp;    - Total temperature [degR]
            <br>-4- &nbsp;&nbsp; Pt &nbsp;&nbsp;     - Total pressure [psia]
            <br>-5- &nbsp;&nbsp; ht  &nbsp;&nbsp;    - Total enthlapy [BTU/lbm]
            <br>-6- &nbsp;&nbsp;  rhot &nbsp;&nbsp;  - Total density [lbm/ft3]
            <br>-7- &nbsp;&nbsp; gamt  &nbsp;&nbsp;  - Total specific heat ratio
            <br>-8- &nbsp;&nbsp; Ts    &nbsp;&nbsp;   - Static temperature [degR]
            <br>-9- &nbsp;&nbsp; Ps    &nbsp;&nbsp;   - Static pressure [psia]
            <br>-10- &nbsp;&nbsp; hs   &nbsp;&nbsp;  - Static enthalpy [BTU/lbm]
            <br>-11- &nbsp;&nbsp; rhos  &nbsp;&nbsp;  - Static density [lbm/ft3]
            <br>-12- &nbsp;&nbsp; gams  &nbsp;&nbsp;   - Static specific heat ratio
            <br>-13- &nbsp;&nbsp; Vflow &nbsp;&nbsp;  - Flow velocity [ft/sec]
            <br>-14- &nbsp;&nbsp; MN    &nbsp;&nbsp;  - Mach number
            <br>-15- &nbsp;&nbsp; A     &nbsp;&nbsp;   - Flow area [in2]
            <br>-16to21-  &nbsp;&nbsp; Species array values, defined in canteraload.m
            <br>-22to25-  &nbsp;&nbsp; Future use
    </td></tr>
    <tr><td>FA_Data</td><td>Block additional calculation data, 1x1 vector including:
    <br>- 0 - future use</td></tr>
</table>

<br><br>
<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->

<div class="maskvars">
        Flow Add (Cantera) Mask Variables
</div>
<p>
    No mask variables are needed for this block, since all of the calculations
    depend only on the inputs.
</p>

<br><hr><br>
<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->

<div class = "errors">
    Potential Errors
</div>
<p>
    When using this block, an error will occur if a Cantera object does not exist
    in the workspace as a global variable named 'fs'. An error will also occur
    if this variable does not contain all of the species defined in 'canteraload.m'.
</p>
<br><br>
<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
</body>